Leadtools.Codecs Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.12.17
WriteComments(String,Int32,Generic RasterCollection) Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class > WriteComments Method : WriteComments(String,Int32,Generic RasterCollection) Method




fileName
A String that contains the file name.
pageNumber
1-based index of the page at which to write the comment.
comments
A collection of RasterCommentMetadata objects containing he comments data.
Writes one or more comments to an existing file.

Syntax

Visual Basic (Declaration) 
Overloads Public Sub WriteComments( _
   ByVal fileName As String, _
   ByVal pageNumber As Integer, _
   ByVal comments As RasterCollection(Of RasterCommentMetadata) _
) 
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim fileName As String
Dim pageNumber As Integer
Dim comments As RasterCollection(Of RasterCommentMetadata)
 
instance.WriteComments(fileName, pageNumber, comments)
C# 
public void WriteComments( 
   string fileName,
   int pageNumber,
   RasterCollection<RasterCommentMetadata> comments
)
Managed Extensions for C++ 
public: void WriteComments( 
   string* fileName,
   int pageNumber,
   RasterCollection<RasterCommentMetadata> comments
) 
C++/CLI 
public:
void WriteComments( 
   String^ fileName,
   int pageNumber,
   RasterCollection<RasterCommentMetadata> comments
) 

Parameters

fileName
A String that contains the file name.
pageNumber
1-based index of the page at which to write the comment.
comments
A collection of RasterCommentMetadata objects containing he comments data.

Example

For an example, refer to ReadComment.

Remarks

This function only applies to TIF, uncompressed EXIF, or FPX files.

When you add or remove tags, the tags array at the end of the file is re-written. When you modify existing tags, the new tag value is added to the file and the IFD is modified as necessary. In all of these cases, there is no image recompression.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also